ggseg3d.RmdSome times, you want to plot the 3d-surfaces from freesurfer. Here, it is easier to use data from freesurfer (like annot and colorlut files) to create colours for the vectors. The data is somewhat more complex than the 2d ggplot polygon version ggseg ggseg3d() will create a plotly plot, which is interactive, and provides another type of flexibility to the user. A lot of credit goes to A.M.Winkler and his Brainder work, which supplied us with the first examples of going from .srf to .ply files, and whose scripts massively aided us in making this work.
The function ggseg3d(), is based in the plotly, it is recommended to get a little familiarized with with plotly.
Out-of-the-box, ggseg() works without supplying any extra information. It will create a base plot of the aparc (dkt) brain segmentations. All [...]_3d atlases have a built in colour column for default colour plotting of the segments.
The data is stored in tibbles, and looks like so:
## # A tibble: 6 x 4
## atlas surf hemi data
## <chr> <chr> <chr> <list>
## 1 dkt_3d inflated left <tibble [36 × 8]>
## 2 dkt_3d inflated right <tibble [36 × 8]>
## 3 dkt_3d LCBC left <tibble [36 × 8]>
## 4 dkt_3d LCBC right <tibble [36 × 8]>
## 5 dkt_3d white left <tibble [36 × 8]>
## 6 dkt_3d white right <tibble [36 × 8]>
To grab all the data for a surface and hemisphere, you should reduce the data to one line, and then unnest()
## # A tibble: 36 x 11
## atlas surf hemi roi annot label mesh acronym lobe area colour
## <chr> <chr> <chr> <chr> <chr> <chr> <lis> <chr> <chr> <chr> <chr>
## 1 dkt_3d infla… right 0001 medi… rh_me… <lis… mdlw <NA> <NA> <NA>
## 2 dkt_3d infla… right 0002 bank… rh_ba… <lis… bnst temp… banks… #1964…
## 3 dkt_3d infla… right 0003 caud… rh_ca… <lis… cdac fron… cauda… #7D64…
## 4 dkt_3d infla… right 0004 caud… rh_ca… <lis… cdmf fron… cauda… #6419…
## 5 dkt_3d infla… right 0005 corp… rh_co… <lis… cc <NA> corpu… <NA>
## 6 dkt_3d infla… right 0006 cune… rh_cu… <lis… cuns occi… cuneus #DC14…
## 7 dkt_3d infla… right 0007 ento… rh_en… <lis… entr temp… entor… #DC14…
## 8 dkt_3d infla… right 0008 fusi… rh_fu… <lis… fsfr temp… fusif… #B4DC…
## 9 dkt_3d infla… right 0009 infe… rh_in… <lis… infp pari… infer… #DC3C…
## 10 dkt_3d infla… right 0010 infe… rh_in… <lis… inft temp… infer… #B428…
## # ... with 26 more rows
Particularly notice the mesh column, which is a list column of lists. In there is all the 6 vectors needed to create the mesh of the tri-surface plot. You’ll also need to notive the label, annot and area columns, which are likely the columns you will be matching on when proviging with your own data for colours. You need to be meticulous when fixing your data, be sure it matches. The function should give you a warning if it’s struggling to match something.
The column you want to use for colour, needs to be supplied to the colour option, and you’ll likely want to supply it to the text option, as this will add another line to the plotly hover information.
You can also change the palette. Choose from ALL the paletteer palettes, just use their name.
You can also provide custom colour palettes either in hex or R-names
ggseg3d(.data = someData, atlas = dkt_3d,
colour = "p", text = "p",
palette = c("forestgreen", "white", "firebrick")) ggseg3d(.data = someData, atlas = dkt_3d,
colour = "p", text = "p", palette = c("#ff0000", "#00ff00", "#0000ff"))If you want to alter the colour of NA regions, supply na.colour
ggseg3d(.data = someData, atlas = dkt_3d,
colour = "p", text = "p",
na.colour = "black", camera="medial") ggseg3d(.data = someData, atlas = dkt_3d,
colour = "p", text = "p",
na.colour = "#ffff00", camera="medial")If you are plotting the sub-cortical structures, you might want to reduce the opacity of the NA structures, so that you can see the more medial structures.